Real-time hierarchical protocol decoding

ABSTRACT

Real-time USB class level decoding is disclosed. In some embodiments, a first packet associated with a USB class level operation associated with a target USB device that is being monitored is received. A second packet generated by a USB hardware analyzer configured to observe USB traffic associated with the target USB device is received. It is determined based at least in part on a time associated with one or both of the first packet and the second packet that the class level operation has timed out.

CROSS REFERENCE TO OTHER APPLICATIONS

This application is a continuation of co-pending U.S. patent applicationSer. No. 14/547,040, entitled REAL-TIME HIERARCHICAL PROTOCOL DECODING,filed Nov. 18, 2014, which is a continuation of U.S. patent applicationSer. No. 13/656,616, now U.S. Pat. No. 8,918,550, entitled REAL-TIME USBCLASS LEVEL DECODING, filed Oct. 19, 2012, which is a continuation inpart of U.S. patent application Ser. No. 12/870,759, now U.S. Pat. No.8,321,604, entitled REAL-TIME USB CLASS LEVEL DECODING, filed Aug. 27,2010, all of which are incorporated herein by reference for allpurposes.

BACKGROUND OF THE INVENTION

Universal Serial Bus (USB) analyzers are used by manufacturers and otherdevelopers of USB devices, software (e.g., drivers), firmware, etc. tomonitor and analyze communications on the Universal Serial Bus (USB).For example, communications between a target USB devices and a targethost to which the device has been connected via a USB port on the targethost may be monitored to ensure the device is communicating properlywith the target host and vice versa in accordance with applicable USBstandards and protocols.

A hardware USB analyzer typically comprises a stand alone or otherhardware device having a first set of connectors to enable the analyzerto be connected so as to be able to observe traffic between a target USBdevice and a target host; hardware and/or firmware to decode signalsobserved on the USB connection being monitored into USB packets; andhardware, logic, and/or an external connector to enable the analyzer tobe connected to an analysis PC and to forward to the analysis PC.

The USB base specifications define protocols that govern communicationon the USB bus. Device class codes are defined to enable a USB device toidentify itself as being a member of one or more classes of device, forexample by including associated USB class code and/or device descriptorinformation in the “enumeration” information the device communicates tothe host upon initial connection. Device classes may have one or morelevel of subclass, and each of these may have one or more differentprotocols associated with it. For each USB device class, a classspecification defines class-specific protocols. In this way, forexample, a USB driver developed independently of a USB device should beusable with the device so long as each conforms to the same class and/ordevice-specific protocols defined in applicable USB specifications.

BRIEF DESCRIPTION OF THE DRAWINGS

Various embodiments of the invention are disclosed in the followingdetailed description and the accompanying drawings.

FIG. 1 is a block diagram illustrating an embodiment of a hardware USBanalyzer.

FIG. 2 is a block diagram illustrating an embodiment of a USB analyzer.

FIG. 3 is a block diagram that provides a conceptual representation ofvarious semantic levels that may be associated with USB data.

FIG. 4 is a block diagram illustrating an embodiment of an analysis PC.

FIG. 5 is a flow diagram illustrating an embodiment of a process togenerate an analysis stream.

FIG. 6 is a flow diagram illustrating an embodiment of a process todecode and display monitored USB data.

FIG. 7 is a flow diagram illustrating an embodiment of a process togenerate timeouts in light of class level context.

FIG. 8 is a block diagram illustrating an embodiment of a display ofmonitored USB data decoded to a class level.

FIG. 9 is a block diagram illustrating an embodiment of a circularbuffer.

FIG. 10A is a flow diagram illustrating an embodiment of a process forpreserving enumeration and related information.

FIG. 10B is a flow diagram illustrating an embodiment of a process forpreserving enumeration and related information.

FIG. 10C is a flow diagram illustrating an embodiment of a process forpreserving enumeration and related information.

FIG. 11 is a flow diagram illustrating an embodiment of a process forreal-time class level decoding.

FIG. 12 is a flow diagram illustrating an embodiment of a process fordisplaying USB class level information.

FIG. 13 is a flow diagram illustrating an embodiment of a process forUSB transaction level information.

FIG. 14 is a state diagram illustrating an embodiment of a process toswitch between class level and transaction level views.

FIG. 15 is a state diagram illustrating an embodiment of a process toswitch between class level and transaction level views.

FIG. 16 is a block diagram illustrating an embodiment of a class levelview.

FIG. 17 is a block diagram illustrating an embodiment of a transactionlevel view.

FIG. 18 is a flow diagram illustrating an additional embodiment of aprocess 1800 to generate timeouts in light of class level context.

FIG. 19 is a flow diagram illustrating an additional embodiment of aprocess 1900 to generate timeouts in light of class level context.

FIG. 20 is a flow diagram illustrating an additional embodiment of aprocess 2000 to generate timeouts in light of class level context.

DETAILED DESCRIPTION

The invention can be implemented in numerous ways, including as aprocess; an apparatus; a system; a composition of matter; a computerprogram product embodied on a computer readable storage medium; and/or aprocessor, such as a processor configured to execute instructions storedon and/or provided by a memory coupled to the processor. In thisspecification, these implementations, or any other form that theinvention may take, may be referred to as techniques. In general, theorder of the steps of disclosed processes may be altered within thescope of the invention. Unless stated otherwise, a component such as aprocessor or a memory described as being configured to perform a taskmay be implemented as a general component that is temporarily configuredto perform the task at a given time or a specific component that ismanufactured to perform the task. As used herein, the term ‘processor’refers to one or more devices, circuits, and/or processing coresconfigured to process data, such as computer program instructions.

A detailed description of one or more embodiments of the invention isprovided below along with accompanying figures that illustrate theprinciples of the invention. The invention is described in connectionwith such embodiments, but the invention is not limited to anyembodiment. The scope of the invention is limited only by the claims andthe invention encompasses numerous alternatives, modifications andequivalents. Numerous specific details are set forth in the followingdescription in order to provide a thorough understanding of theinvention. These details are provided for the purpose of example and theinvention may be practiced according to the claims without some or allof these specific details. For the purpose of clarity, technicalmaterial that is known in the technical fields related to the inventionhas not been described in detail so that the invention is notunnecessarily obscured.

Real-time USB class level decoding is disclosed. In various embodiments,a hardware USB analyzer is configured to receive and monitor USBcommunications, e.g., between a target USB device and an associatedtarget host. The analyzer provides an analysis stream, e.g., comprisingUSB packets observed being sent between the target device and the targethost, to an analysis personal computer (PC) or other analysis computer.The analysis PC runs analysis software configured to enable the PC todecode the monitored USB traffic to the class level, and to display to auser via a display device class level information, such as class levelinstructions and commands sent between the target device and the targethost. In some embodiments, if the analyzer has not observed a packetwithin a prescribed time, the analyzer outputs a periodic “no activity”packet or other report to the analysis PC. The analysis software runningon the PC uses a timestamp or other time associated with the “noactivity” packet, and the time of the last observed packet between thetarget device and the target host, along with an awareness of a classlevel state (e.g., a pending and not yet completed class levelinteraction, such a “read” from a “mass storage” device), to detect andreport timeouts in an efficient and timely manner.

In some embodiments, the analyzer stores monitored packets in a circularbuffer as they are received. Once the buffer is full older packets areoverwritten as new packets are received and decoded. Upon receiving a“capture” command or other indication the contents of the buffer areprovided to the analysis PC in a “capture” stream. In some embodiments,as packets are received at the analyzer the analyzer determines whetherthey are associated with an initial enumeration of the device and/orpost-enumeration information such as device descriptor data. Suchinformation is required to be known and used in some embodiments toenable class level decoding; however, a “capture” may be started(relatively) long after enumeration information has been received. Insome embodiments, enumeration records are copied and indexed, e.g.,prior to being overwritten, to ensure they (or associated informationderived from same) will be available for use at a later time to enableclass level decoding of a subsequently “captured” stream.

In some embodiments, the analysis software is configured to displayinformation in a way such that packets that are likely not of interestto the user will not be displayed in a way that prevents the user fromseeing, for example in a reasonable compact and/or concurrently viewabledisplay area, a sequence of related packets that are of interest.Example of packets that may not be of interest are successive “start offrame” (SOF) packets sent periodically to mark the start of a new frameand exchanges between a target host and a target device of successivepairs of “IN” and “NAK” packets, i.e., packets exchanged as the hostperiodically polls the device for data during a period of time duringwhich for whatever reason the device has no data to send to the host. Invarious embodiments, the manner in which such packets not particularlyof interest are grouped and displayed may vary depending on whether aclass level view or a transaction level view has been selected.

FIG. 1 is a block diagram illustrating an embodiment of a hardware USBanalyzer. In the example shown, USB analyzer 102 is configured tomonitor a USB connection between a target USB device 104 and a targethost 106. A first USB cable/connector 108 connects the target USB device104 to the analyzer 102; and a second USB cable/connector 110 connectsthe analyzer 102 to the target host 106. Examples of target USB devicesinclude without limitation a printer, a mass storage device, and a humaninterface device (HID) such as a mouse or keyboard. Connected in the wayshown in FIG. 1, the analyzer 102 receives USB bus signals communicatedeither by the target USB device to the target host or by the target hostto the target device, enable the analyzer to monitor the bidirectionalcommunications. Typically the analyzer is configured to listenpassively, such that the target host and target device believe they havea direct USB connection between them. The analyzer 102 provides ananalysis stream via an analysis stream output connection 112 to ananalysis PC (or other computer) 114. In some embodiments the connection112 is itself a USB connection between the analyzer 102 and the analysisPC 114. In various embodiments, the analysis PC 114 and target host 106may comprises the same physical system, e.g., a PC to which the device104 has been connected via the analyzer 102 and connections 108 and 110.

FIG. 2 is a block diagram illustrating an embodiment of a USB analyzer.In the example shown, hardware USB analyzer 102 of FIG. 1 is shown toinclude a USB packet decoder 202 configured to receive and decodesignals sent between the target device and target host shown in FIG. 1.In the example shown in FIG. 2 arrows indicate observation of a packetsent by the target device 104 via connection 108 intended for the targethost 106 connected to the analyzer 102 via connection 110; howeverpackets sent from the host to the device also would be received anddecoded. The USB packet decoder 202 provides observed packets to ananalysis stream generator 204, which includes observed packets in ananalysis stream provided as output on connection 112 to the analysis PC.In some embodiments, the analyzer 102 affixes an analyzer timestamp toeach observed packet sent via connection 112. In the example shown, atimestamp generator and logic 206 generates and provides the timestamp.In some embodiments, during periods of inactivity on the monitored bus(i.e., 108, 110 in this example) the analysis stream generator isconfigured to output, for example periodically, a “no activity” or otherperiod packet indicating that no packet has been observed on themonitored bus during an associated period. For example, in someembodiments the analyzer timestamp comprises 16 bits, and a “noactivity” packet is sent every time the timestamp rolls over without anobserved packet being seen on the monitored bus.

FIG. 3 is a block diagram that provides a conceptual representation ofvarious semantic levels that may be associated with USB data. In theexample shown, the multi-layer conceptual representation 300 comprisesan electrical signal layer 302. At the physical wire and connectorlevel, USB devices and target hosts send and receive signals on wires.For example, a USB 1.0 or 2.0 cable has 4 wires, two for power (Vcc,GND) and two for data (D+, D−). Signals on the bus a decoded to identifycorresponding packets (304). A series of packets exchanged in aprescribed sequence comprise a transaction (306). For example, an “IN”transaction by which a host polls and receives data from a device maycomprise an “IN” packet sent by the host to the device, a “DATA” packetsent by the device back to the host, and an “ACK” packet from the hostto the device acknowledging receipt of the data. (If the device had nodata, the device would respond to the IN packet with a “NAK” packet, andthat would be the end of that particular exchange.) Another example isan “OUT” transaction (OUT packet from host to device, followed by DATApacket providing data from host to device, followed finally by an ACKpacket from the device to the host acknowledging receipt of the data).USB classes enable a further semantic level to be understood and used.At the class level, and depending on the class, subclass, etc., a set ofone or more related transactions may comprise a class level transfer,command, instruction, etc. For example, in the case of a USB device inthe “mass storage” class, a “read” transfer may comprises a “commandtransport” used to initiate the operation, a “data transport” totransfer the data, and a “status transport” to mark completion of thetransfer and synchronize state. Each of these “transports” may in turncomprise one or more transactions. For example, the data transport maycomprise a series of IN transactions, each of which is used to deliverto the host a portion of the data requested to be read. As noted above,the class level meaning of a series of one or more transactionstypically is defined in a class or class-related specification.

In FIG. 3 a plurality of classes 1 through n (308) are represented. Insome embodiments, e.g., in the context of a device in a particularconfiguration connected to a compatible host, one or more classes,subclasses, and/or class and/or sub-class specific protocols and/orconfigurations may apply. In some embodiments, class, subclass,protocol, and/or device descriptor information may be provided by thedevice and/or exchanged upon initial connection and/or startup (e.g.,boot) and may include the enumeration information mentioned above and/orpost-enumeration information such as device descriptor information. Invarious embodiments, such enumeration and/or post-enumerationinformation is used, e.g., by the analysis software on the analysis PC,to decode observed USB traffic to the class level and to present, e.g.,via a display, information at the class level in a human readable form.

FIG. 4 is a block diagram illustrating an embodiment of an analysis PC.In the example shown, the analysis PC 114 of FIG. 1 is shown to includea communication interface 402, such as a USB, network, or otherinterface, configured to communication with a hardware USB analyzer viaconnection 112. The communication interface 402 provides observedpackets (and other data, such as the periodic “no activity” packetsmentioned above) comprising an analysis stream received via connection112 to a transaction level decoding engine 404. Transaction leveldecoding engine 404 associates the packets into groups comprisingtransactions and provides transaction level information to class leveldecoding engine 406. In some embodiments, transaction level decodingengine 404 passes up to class level decoding engine 406 any “noactivity” packets included in the analysis stream (or in someembodiments data comprising same, such as the analyzer timestamp). Theclass level decoding engine 406 analyzes the received transactioninformation to derive class level information, such as to identify classlevel transfers, commands, and instructions. In various embodiments,class level decoding engine 406 uses class and/or device descriptorand/or other data observed during device enumeration or post-enumerationto determine how to decode information at the class level.

In some embodiments, class level decoding engine 406 is configured toreceive “no activity” packets or other periodic packets generated by theanalyzer during periods of quiet on the monitored bus, and/or datacomprising same, such as the analyzer timestamp, and to use the receivedno activity data along with an awareness of class level state (e.g.,which if any class level operations are pending) to generate and displayclass level timeout events, as described more fully below in connectionwith FIG. 7.

In the example shown in FIG. 4, a user interface code 408 receivesinformation from the class level decoding engine and displays classlevel information via a display device 410. In some embodiments, userinterface code 408 responds to inputs, e.g., from a user, selecting aview to be displayed. For example, in some embodiments if“classification” or “class level decoding” are enabled, informationdecoded to the class level is displayed; but if classification is notenabled then transaction level information is displayed. In variousembodiments one or more of transaction level decoding engine 404, classlevel decoding engine 406, and user interface code 408 comprises anentity provided by using a processor comprising PC 114 to executeassociated software instructions.

FIG. 5 is a flow diagram illustrating an embodiment of a process togenerate an analysis stream. In some embodiments, the process of FIG. 5is implemented on a hardware USB analyzer. In the example shown,electrical signals sensed on the monitored bus are decoded into packets(502), for example by decoder 202 of FIG. 2. Once a packet is decoded(504), an analyzer packet including the observed USB packet data, atimestamp, and other attributes is included in an analysis streamprovided as output (506). If no packet has been detected within aprescribed (e.g., configurable) period (508), a “no activity” packetbearing an analyzer timestamp is generated and included in the analysisstream (510). In some embodiments, a “no activity” or other packet isoutput periodically by the analyzer regardless of whether there has beenactivity on the monitored bus, and in some such embodiments step 508 isomitted and/or comprises a step of determining whether the time toprovide the “no activity” or other periodic packet as output hasarrived. In some embodiments, a 16 bit analyzer timestamp is used and aperiodic packet output, regardless of activity on the monitored bus,each time an associated counter rolls over. Operation continues asdescribed above until done (512), e.g., the analyzer is disconnectedand/or a stop command is received from the analysis PC.

FIG. 6 is a flow diagram illustrating an embodiment of a process todecode and display monitored USB data. In some embodiments, the processof FIG. 6 is implemented by an analysis computer such as analysis PC 114of FIGS. 1 and 4. In the example shown, as packets are received (602)they are decoded to the transaction level (604). Transaction levelinformation is in turn decoded to the class level (606), and class leveloperations, commands, and instructions are displayed (608).

FIG. 7 is a flow diagram illustrating an embodiment of a process togenerate timeouts in light of class level context. In some embodiment,the process of FIG. 7 is implemented by a class level decoding enginesuch as class level decoding engine 406 of FIG. 4. In the example shown,a “no activity” event is received (702). In various embodiments, the noactivity event may comprise a no activity packet generated and sent bythe USB analyzer and/or an event or other record or indication derivedtherefrom. For example, in some embodiments a USB analyzer is configuredto output a dummy or other packet every time a 16-bit or other counterrolls over. The analysis PC is configured to generate a time out eventif, for example, n such dummy or other no activity packets are receivedwithout an intervening packet comprising data observed on the monitoredbus. In some embodiments, at intervening levels of along the path to theclass level decoding engine, one or more such events may be collectedand a next level timeout event generated. For example, the transactionlevel decoding engine may accumulate m packet level timeout eventsbefore generating a transaction level timeout and/or passing up to theclass level decoding engine a transaction level generated timeout event.Once the timeout event is received at the class level decoding engine(702), if a class level operation is pending (704)—for example one ormore transactions comprising a class level transfer have been observedbut one or more remaining transactions expected to be received inconnection with the class level transfer, for example by virtue of therequirements and protocols set forth in applicable classspecifications—a time associated with the “no activity” event iscompared with a time associated with the class level operation, e.g., atimestamp of a first received packet associated with the class leveloperation (706). If the elapsed time exceeds a prescribed threshold(708) a class level timeout event is generated and an associated alertdisplayed to the user (710). In some embodiments, the elapsed time isdetermined by accumulating successive transaction level or otherreceived timeout events and generating a class level timeout event ifmore than a prescribed number of such received timeout events arereceived successively without a class level operation completion eventbeing provided by the class level decoding engine as output. If no classlevel timeout has been determined to have occurred, or if no class leveloperation is pending, or once the timeout event is generated and alertdisplayed, the process ends.

FIG. 8 is a block diagram illustrating an embodiment of a display ofmonitored USB data decoded to a class level. In the example shown, thedisplay 800 includes a record column 802 in which information describingthe nature and meaning of a class level record is displayed and a datacolumn 804 in which corresponding data associated with the record isdisplayed. In the example shown, data associated with an operation toread data from a USB mass storage device is displayed. In the first line(row) the “read” operation is represented by a “read” record, with aminus symbol indicating the record has been expanded to show componentrecords in subsequent rows. In the data column data indicating thelogical block address (LBA) and length of the data to be read, alongwith an indication that the operation was observed to have beencompleted successfully (“passed”), are displayed. The read operation isshown to comprise a command transport, a data transport, and a statustransport. The data transport record has been expanded to show aplurality of IN transactions comprising the data transport. A first INtransaction has been expanded to shown the IN, DATA, and ACK packetsthat comprise the transaction. In some embodiments, if the sequence oftransports shown in FIG. 8 had not been observed to have been completedwithin a prescribed time, an error or other indication would have beendisplayed. For example, in some embodiments, based on an awareness ofthe class level context (here, a pending read from a device that is amember of a “mass storage” class of device), a class level decodingengine or related element is configured to generate a timeout if aprescribed amount of time has passed between a last confirmedtransaction one or more subsequent transactions and/or packets expectedto be received to indicate completion of the class level operation, asdetermined for example based on a “no activity” or like packet and/orinformation received from the analyzer and propagated up to the classlevel decoding engine. In such a case, a “timeout” or other error,instead of the “passed” status displayed in FIG. 8, would be displayed.

Using the approach described above, a timeout or other error incompletion of a class level transfer or other class level operation canbe detected in real time. In non-real-time analysis, it is possible tolook ahead in the analysis stream to see whether and/or at what timesubsequent packets associated with a class level transfer were received.However, to perform real-time analysis, and in particular to timelydetect timeouts and display an associated alert to a user in real-time,techniques such as those described herein are required to enable theanalysis software to determine, in real-time and without the benefit ofbeing able to look indefinitely into the future, that a class leveloperation has timed out. Otherwise, the user's experience would be thatthe display would not change, which could be caused by reasons otherthan a failure in completion of the class level transfer, e.g., failureof the hardware analyzer, a problem with the connection between theanalyzer and the analysis PC, and/or a failure of the analysis softwareand/or PC.

In various embodiments, a hardware USB analyzer and/or analysis PC isconfigured to use a circular buffer to store packets and/or recordscomprising a monitored USB stream. Once a connection is established anddata is observed on the monitored bus, packets are decoded andassociated records stored in the circular buffer, for further use andanalysis in the event an indication is received that real-time “capture”and analysis are desired. A circular buffer is used to limit the memoryor other storage used to store records. Once the command to beginreal-time capture is received, records are pulled from the buffer andanalyzed, e.g., by decoding information to the transaction and/or classlevel, as applicable.

FIG. 9 is a block diagram illustrating an embodiment of a circularbuffer. In the example shown, circular buffer 900 comprises a pluralityof storage locations 902 into which an allocated block of memory orother storage has been organized. Conceptually, in some embodiments afirst record would be stored in the leftmost location, a next record ina next location to the right, etc., until a last (in this caserightmost) storage location was reached. As indicated by the arrow 904,a next-received data would be stored in the leftmost location,overwriting the data stored in that location as the outset. Writing(storage) would advance to the right, overwriting previously storeddata, until the last location was reached again, at which point writingwould return to the first location, etc. This approach allows a limitedamount of storage to be allocated to store observed USB data, howeveronce the buffer has been filled new data can only be stored byoverwriting data observed and stored earlier. Absent the use oftechniques described herein, this approach could result in theoverwriting of data that may be required in the future to support classlevel decoding in real-time, such as enumeration information and devicedescriptor information, which typically is exchanged when a device isfirst connected and/or at startup and, therefore, may be among the datathat would first be overwritten once a circular buffer becomes full.

In some embodiments, data that may be required in the future to enableclass level decoding in real-time of a USB data stream as it isreceived, such as enumeration and device descriptor information, isstored in another location (other than the circular buffer) prior to itsbeing overwritten.

FIG. 10A is a flow diagram illustrating an embodiment of a process forpreserving enumeration and related information. In the example shown,USB data observed on a monitored bus is monitored to detect recordscomprising enumeration information (1002). Detected enumeration records(1004) are copied to storage location other than the circular buffer andindexed to facilitate retrieval (1006). Non-enumeration records andenumeration records alike are written to the circular buffer (1008). Theprocess continues until done (1010), e.g., the analyzer is disconnectedfrom the target device and/or target host.

FIG. 10B is a flow diagram illustrating an embodiment of a process forpreserving enumeration and related information. In the example shown,when a packet is received (1030) it is determined whether it isenumeration (or other device class, identity, and/or configuration)related (1032). If so, the associated record is tagged as an enumerationrecord (1034). In some embodiments, enumeration records are tagged onlyif class level decoding is enabled. The untagged record (if the receivedpacket was not enumeration related) or the tagged record (in the case ofan enumeration record) is stored in the circular buffer (1036).

FIG. 10C is a flow diagram illustrating an embodiment of a process forpreserving enumeration and related information. In the example shown,upon receiving an indication that the circular buffer is full (orapproaching being full) (1050), the buffer is checked for the presenceof enumeration records (1052), e.g., by checking for tags such as thosementioned in connection with FIG. 10B. If any enumeration records arefound (1054), they are copied to another location and indexed (1056). Ifno enumeration records are found (1054) or if so once all such recordshave been copied and indexed (1056), writing the circular buffercontinues/resumes (1058), including as applicable overwriting previouslystored enumeration (if any) and/or non-enumeration records.

FIG. 11 is a flow diagram illustrating an embodiment of a process forreal-time class level decoding. In the example shown, upon receiving anindication to begin real-time class level decoding (1102), enumerationrecords associated with the target device are retrieved (1104). In someembodiments, the records are retrieved either from the circular buffer,if still present there, or if not from a location to which they havebeen copied. In some embodiments, a location into which enumerationrecords would have been copied, if needed to avoid their beingoverwritten, is checked; if enumeration records are present they areretrieved and used, if not the records are played from the buffer inorder and enumeration records are processed as they are encountered.Once retrieved (and/or encountered in the buffer) enumeration recordsare processed and associated device information is extracted, displayed,and/or used to configure the class level decoding engine to decodeassociated USB data to the class level (1106). Once the enumerationrecords have been processed subsequent records are processed in light ofthe enumeration information determined from the enumeration records,including by decoding information to the class level in light of thedevice and other enumeration information derived from the enumerationrecords (1108).

USB target devices and hosts generate some packets that are required forproper operation and implementation of applicable USB protocols butwhich typically are not, at least individually, of particular interestto a developer. For example, a start of frame (SOF) packet is outputperiodically by a target host to delineate frame boundaries. Likewise,the USB protocols are host-centric, so typically a host willperiodically poll connected devices to invite them to send data to thehost. If the device has no data, e.g., a mouse or other input devicethat has not been touched by the user for a time, a sequence of INpackets inviting the device to send data and responsive NAK packetsindicating the device has no data for the host will be sent. Displayshave limited physical dimensions and resulting display area, and one cansee by referring to FIG. 8 for example that during relatively idleperiod or periods when activity of interest is occurring but on arelatively slow time scale the display could become filled with a seriesof IN-NAK pairs or SOF packet records, pushing information of interestout of the viewing area, or obscuring such information by interspersinguninteresting records that are in this sense merely noise.

In some embodiments, records associated with packets or other data thatis not expected to be of particular interest are not necessarilydisplayed individually and/or immediately. Instead, such records areaccumulated and represented as a group, for example in a manner thatdoes not interfere with the display of other records that may be ofgreater interest. In various embodiments, packets, transactions, and/orother data and events not likely to be of interest are accumulated. Oncea transaction and/or class level event is ready to be displayed, theaccumulated records not of interest and/or a group representation ofthem, is/are displayed, for example, in a row or other area just aboveor otherwise adjacent to and/or separate from a display area in whichthe transaction and/or class level record(s) is/are to be displayed.

FIG. 12 is a flow diagram illustrating an embodiment of a process fordisplaying USB class level information. In the example shown, when apacket is received (1202) a determination is made whether the packet islikely to be of interest (1204), e.g., based on the packet type and/or atransaction or other interaction with which the packet is associated.For example, SOF packets and IN-NAK packet pairs may be deemed notlikely to be of interest. If a received packet (1202) is not likely tobe of interest (1204), the packet is accumulated with other similarpackets (1206) and not immediately displayed. If a packet is of interest(1204), a determination is made whether a transaction with which it isassociated is complete (1208). If so, an associated transaction recordis generated (1210) and, depending on the display mode and user actions,displayed. For example, in the example shown in FIG. 8 recordsassociated with transactions comprising the data transport aredisplayed, whereas those comprising the command transport and the statustransport are not. In a transaction record is generated (1210), adetermination is made as to whether a class level transfer or otheroperation with which the transaction is associated is complete (1212).If so, a record associated with the class level transfer or otheroperation is generated and displayed and a group representation of anyaccumulated records not likely to be of interest is displayed, e.g.,just before or other near or as part of the class records. The processcontinues as subsequent packets are received and process, until done(1216).

FIG. 13 is a flow diagram illustrating an embodiment of a process forUSB transaction level information. In the example shown, a packet isreceived (1302). If the packet is not of interest (1304) it isaccumulated with similar packets (if any) and not immediately displayed(1306). If the packet is of interest and an associated transaction isnow complete (1308), a record associated with the transaction and agroup representation of any accumulated packets not deemed to be ofinterest are displayed (1310). The process continues until done (1312).

FIG. 14 is a state diagram illustrating an embodiment of a process toswitch between class level and transaction level views. In the exampleshown, a display can be toggled between a first view (1402) in whichrecords not considered of particular interest are accumulated andrepresented as a group based on class level events, as in FIG. 12, and asecond view (1404) in which records not considered of particularinterest are accumulated and represented as a group based on transactionlevel events, as in FIG. 13. Using this approach, records not ofinterest are represented in the manner that least interferes with thedisplay of information likely to be of interest, either at the classlevel or transaction level, depending on which class level decoding(and/or an associated view) has been enable.

FIG. 15 is a state diagram illustrating an embodiment of a process toswitch between class level and transaction level views. In someembodiments, the process of FIG. 15 implements the state diagram of FIG.14. In the example shown, if classification (i.e., class level decoding)is not enabled (1502), records not considered likely to be of interestare grouped and displayed at the transaction level (1504). Ifclassification is enabled (1502), records not considered likely to be ofinterest are grouped and displayed at the class level (1506). Theprocess continues until done (1508).

FIG. 16 is a block diagram illustrating an embodiment of a class levelview. In the example shown, display 1600 includes a record column 1602and a data column 1604. The device may be, for example, a mass storagedevice. In the example shown records associated with three “read”transfers at the class level are displayed. The first transfer is shownin the first row, in a “collapsed” fashion with summary informationshown in the data column and the “passed” status indicated. In thesecond row, immediately before the display of records associated with asecond “read” beginning with the third row, a group representation of 93intervening SOF packets is displayed, with a summary listing of theframes they represent in the data column. Note that displaying 93 SOFpackets in successive rows would have resulted in the user beingrequired to scroll down through 93 records before seeing the next “read”transfer. In the example shown, the “read” transfer record for thesecond transfer shown in FIG. 16, beginning on the third row, has beenexpanded to show in addition component records for the commandtransport, data transport, and status transport class level eventscomprising the transfer. In this example, nine SOF packets that may havebeen intersperse with the packets comprising the component class leavetransports and/or transactions comprising those transports arerepresented as a group in the first row after the top class level “read”record (i.e., the fourth row of the display 1600 as shown). In this waythe component transports and the transactions comprising thosetransports can be viewed together, without intervening records that arenot of interest.

FIG. 17 is a block diagram illustrating an embodiment of a transactionlevel view. In the example shown, display 1700 includes a record column1702 and a data column 1704. In this example, a transaction level viewis provided. Rather than grouping packets not of interest, here as inFIG. 16 SOF packets, around class level events, in the example shown inFIG. 17 such packets are grouped and displayed around transaction ofinterest. For example, in the first row a group of three SOF packets isrepresented in a single entry, prior to an expanded IN transactionrecord (and component packets). In some embodiments, even if one or moreof the SOF packets had been interspersed in the traffic observed on themonitored bus, such packets would be represented by a group entry listedjust prior to (or, alternatively, after) the record(s) associated withthe transaction just prior to and/or during the pendency of which theywere observed. For example, in the example shown in FIG. 17 if one ormore of the three SOF packets occurred between the IN packet and the ACKpacket shown in the third and fifth rows of the display 1700, such SOFpackets would be represented as shown in FIG. 17, i.e., by a singlegroup entry listed prior to the IN transaction record listed in thesecond row. Note that no SOF packets happened to have occurred betweenthe final two IN transactions shown in the last two rows of FIG. 17.

While in various embodiments described above IN-NAK packet pairs and SOFpackets are used as examples of packets that may not be of particularinterest, for example to a user viewing a display of USB data monitoredusing a USB analyzer, the techniques described herein may be applied todisplay in a non-intrusive way other packets not of particular interest.For example, in the context of USB 3.0, packets that may not be ofparticular interest may include, without limitation, IsochronousTimestamp Packets (ITP), Link Up (LUP) and/or Link Down (LDN) packets,and/or Link Power Management packets such as LGO and/or LXU packets.

In various embodiments, the SOF and/or other packets not of interestthat are displayed as collapsed groups as shown in FIG. 17 areinterspersed between individual transactions that in some embodimentsmay eventually be grouped into a class-level parent record. In someembodiments, during the capture, individual SOF collapsed groups arepreserved, regardless of the current display mode (i.e., transaction orclass), which in various embodiments allows the user to switch displaymodes after the capture is over.

In some embodiments, when in class-level display mode, as in FIG. 16,all of the interspersed SOF collapsed groups that were interspersed inthe middle of a parent-level class record as represented in atransaction display mode are collapsed and summed together. This resultsin previously individually-displayed SOF collapsed groups, for examplewith SOF counts of 3, 4, and 1 in the example shown in FIG. 17, beingmerged for representation in the class-level display (as in FIG. 16),resulting in this example in their being represented by a single groupof 8 SOFs.

In various embodiments, timeouts are managed in real time for thesecollapsed SOF (and IN/NAK) groups so that if a legitimate class recordspans a long period of time, collapsed SOF groups (summed over all ofthe transaction-level SOF groups) are emitted periodically and give asense of bus activity to the user of the analyzer. In some embodiments,timeouts are managed on a “per bucket” basis (SOF, IN/NAK to aparticular device+endpoint pair, PING/NAK, etc.).

Techniques described herein facilitate the display of monitored USBdata, decoded to a class level, in real-time.

FIG. 18 is a flow diagram illustrating an additional embodiment of aprocess 1800 to generate timeouts in light of class level context. Insome embodiments, process 1800 of FIG. 18 is implemented by a classlevel decoding engine such as class level decoding engine 406 of FIG. 4.At 1804, the beginning of a class level operation is detected. After theclass level operation is detected, a timer is started at 1806. Forexample, a timer at the analysis PC configured to expire after apredetermined period of time is started at 1806. The predeterminedperiod of time may be based on an estimate of how long the class leveloperation takes to complete. At 1808, whether the class level operationis completed is determined. If the class level operation is completedbefore the timer expires, then the timer at the analysis PC is reset at1814, and process 1800 is terminated without any timeout event. If theclass level operation is not yet completed when the timer expires at1810, then an error is returned at 1812, indicating that a timeout eventhas occurred. After the timeout event, the timer is reset at 1814, andprocess 1800 is terminated.

FIG. 19 is a flow diagram illustrating an embodiment of a process 1900to generate timeouts in light of class level context. In someembodiments, process 1900 of FIG. 19 is implemented by a class leveldecoding engine such as class level decoding engine 406 of FIG. 4. At1904, the beginning of a class level operation is detected. After theclass level operation is detected, a start timestamp is recorded at1906. The start timestamp indicates the start time of the class leveloperation. For example, a timestamp of a first received packetassociated with the class level operation is recorded at the analysis PCat 1906. At 1908, whether a next packet is received is determined. If anext packet is received, then the timestamp of the next packet iscompared with the start timestamp at 1910. For example, if the elapsedtime determined based on the comparison exceeds a predeterminedthreshold, then a timeout event has occurred at 1912, and an error isreturned at 1916 before process 1900 is terminated. If the elapsed timedetermined based on the comparison has not exceeded the predeterminedthreshold, then a timeout event has not occurred at 1912, and process1900 is continued by waiting for the next packet at 1908 or until theclass level operation is completed.

FIG. 20 is a flow diagram illustrating an embodiment of a process 2000to generate timeouts in light of class level context. In someembodiments, process 2000 of FIG. 20 is implemented by a class leveldecoding engine such as class level decoding engine 406 of FIG. 4. At2004, the beginning of a class level operation is detected. At 2006,whether a next packet is received is determined. If a next packet isreceived, then whether the received next packet is consistent with theclass level operation is determined at 2008. If the received next packetis not consistent with the class level operation, then an error isreturned at 2010 to indicate that a timeout event has occurred. Forexample, if a particular type of packet is expected to be received nextduring a class level operation, but a different type of packet isreceived, then the received packet is considered inconsistent with theclass level operation at 2008. In one illustrative example with twoclasses A and B, class A operation includes packets A0 A1 A2 A3 in thatorder, and class B operation includes packets B0 B1 B2 in that order. Ifpackets A0 A1 B0 are received, then B0 is determined as inconsistent andan error is returned since class A operation has not yet completed. Ifpackets A0 A1 B1 are received, an error is also returned. If packets A2A3 are received, an error is also returned since A2 cannot appear at thebeginning of a sequence.

Although the foregoing embodiments have been described in some detailfor purposes of clarity of understanding, the invention is not limitedto the details provided. There are many alternative ways of implementingthe invention. The disclosed embodiments are illustrative and notrestrictive.

What is claimed is:
 1. (canceled)
 2. A method of analyzing USB data,comprising: copying an enumeration record from a first storage locationin a buffer configured to store USB data associated with a target USBdevice to a second storage location not in the buffer, based at least inpart on an indication that the enumeration record as stored in thebuffer may be overwritten; and using the enumeration record as stored inthe second location to perform USB class level decoding of a set of USBdata associated with the target device.
 3. The method of claim 2,wherein the enumeration record comprises data included in one or morepackets associated with an enumeration of the target USB device.
 4. Themethod of claim 2, further comprising indexing the copied enumerationrecord to facilitate retrieval of the copied enumeration record from thesecond storage location.
 5. The method of claim 2, wherein the buffercomprises a circular buffer.
 6. The method of claim 2, furthercomprising tagging the enumeration record as stored in the firstlocation with a data value indicating that the enumeration record is anenumeration record.
 7. An analysis system, comprising: a memoryconfigured to store a buffer configured to store USB data associatedwith a target USB device; and a processor coupled to the memory andconfigured to: copy an enumeration record from a first storage locationin the buffer to a second storage location not in the buffer, based atleast in part on an indication that the enumeration record as stored inthe buffer may be overwritten; and use the enumeration record as storedin the second location to perform USB class level decoding of a set ofUSB data associated with the target device.
 8. The analysis system ofclaim 7, wherein the enumeration record comprises data included in oneor more packets associated with an enumeration of the target USB device.9. The analysis system of claim 7, wherein the processor is furtherconfigured to index the copied enumeration record to facilitateretrieval of the copied enumeration record from the second storagelocation.
 10. The analysis system of claim 7, wherein the buffercomprises a circular buffer.
 11. The analysis system of claim 7, whereinthe processor is further configured to tag the enumeration record asstored in the first location with a data value indicating that theenumeration record is an enumeration record.
 12. A method of displayingUSB data, comprising: grouping packets of a first type for visualdisplay in a group entry displayed in a display location that allows aset of one or more class level records associated with a USB class leveloperation to be displayed contiguously without an interveningrepresentation of one or more packets of the first type intervening,even if one or more packets of the first type were interspersedchronologically on a monitored bus with packets comprising the classlevel operation, when in a first display mode; and grouping said packetsof the first type for display, differently than in the first displaymode if required, in one or more group entries displayed in one or moredisplay locations that allow a set of one or more transaction levelrecords to be displayed without an intervening representation of one ormore packets of the first type intervening between two or more recordscomprising a transaction, even if one or more packets of the first typewere interspersed chronologically on a monitored bus with packetscomprising the transaction, when in a second display mode.
 13. Themethod of claim 12, further comprising receiving a user input to changefrom the first display mode to the second display mode.
 14. The methodof claim 13, further comprising grouping packets of the first type sothat for each of one or more transactions packets of the first type thatarrived subsequent to an immediately previous transaction and prior tocomplete of the present transaction are represented in a single groupentry displayed immediately prior to a first transaction recordassociated with the transaction.
 15. The method of claim 12, whereinpackets of the first type comprise start of frame (SOF) packets.
 16. Themethod of claim 12, further comprising accumulating packets of the firsttype as received in real-time pending completion of the USB class leveloperation, when in the first display mode, and displaying the groupentry once the USB class level operation is completed.
 17. The method ofclaim 16, further comprising displaying the set of one or more classlevel records in a location adjacent and subsequent to the group entry.18. An analysis system, comprising: a display device; and a processorcoupled to the display device and configured to: group packets of afirst type for visual display in a group entry displayed on the displaydevice in a display location that allows a set of one or more classlevel records associated with a USB class level operation to bedisplayed contiguously on the display device without an interveningrepresentation of one or more packets of the first type intervening,even if one or more packets of the first type were interspersedchronologically on a monitored bus with packets comprising the classlevel operation, when in a first display mode; and group said packets ofthe first type for display on the display device, differently than inthe first display mode if required, in one or more group entriesdisplayed in one or more display locations that allow a set of one ormore transaction level records to be displayed on the display devicewithout an intervening representation of one or more packets of thefirst type intervening between two or more records comprising atransaction, even if one or more packets of the first type wereinterspersed chronologically on a monitored bus with packets comprisingthe transaction, when in a second display mode.
 19. The analysis systemof claim 18, wherein the processor is further configured to receive auser input to change from the first display mode to the second displaymode.
 20. The analysis system of claim 19, wherein the processor isfurther configured to group packets of the first type so that for eachof one or more transactions packets of the first type that arrivedsubsequent to an immediately previous transaction and prior to completeof the present transaction are represented in a single group entrydisplayed immediately prior to a first transaction record associatedwith the transaction.
 21. The analysis system of claim 18, whereinpackets of the first type comprise start of frame (SOF) packets.
 22. Theanalysis system of claim 18, wherein the processor is further configuredto accumulate packets of the first type as received in real-time pendingcompletion of the USB class level operation, when in the first displaymode, and display the group entry once the USB class level operation iscompleted.
 23. The analysis system of claim 22, wherein the processor isfurther configured to display the set of one or more class level recordsin a location adjacent and subsequent to the group entry.